shared source/wpf/src/host/shimimpl/version.cxx

   1 //------------------------------------------------------------------------
   2 //
   3 //  Copyright (c) Microsoft Corporation.  All rights reserved.
   4 //
   5 //  Description:
   6 //     Implements the connection to PHDLL (PresentationHostDLL.dll v3 or PresentationHost_vX.dll for v4+).
   7 //
   8 // History:
   9 //      2005/05/09 - [....]
  10 //          Created
  11 //      2007/09/20-[....]
  12 //          Ported Windows->DevDiv. See SourcesHistory.txt.
  13 //
  14 //------------------------------------------------------------------------
  15
  16 #include "PreCompiled.hxx"
  17 #include "Version.hxx"
  18 #include "ActivationContext.hxx"
  19
  20
  21 CVersion::CVersion(__in_ecount(1) LPCWSTR pswzVersion):
  22     m_hInstance(0), m_bIsValid(false), m_bIsAttached(false),
  23     m_dwMajor(0), m_dwMinor(0), m_dwBuild(0),
  24     m_pfnActivate(0), m_pfnDeactivate(0), m_pfnForwardTranslateAccelerator(0),
  25     m_pfnSaveToHistory(0), m_pfnLoadFromHistory(0)
  26 {
  27     if (pswzVersion)
  28     {
  29         SetValue(pswzVersion);
  30         ParseVersion(pswzVersion);
  31     }
  32 }
  33
  34 int CVersion::CompareTo(__in_ecount(1) CVersion* pOther)
  35 {
  36     int nResult = this->m_dwMajor - pOther->m_dwMajor;
  37
  38     if (nResult == 0)
  39     {
  40         nResult = this->m_dwMinor - pOther->m_dwMinor;
  41     }
  42
  43     if (nResult == 0)
  44     {
  45         nResult = this->m_dwBuild - pOther->m_dwBuild;
  46     }
  47
  48     return nResult;
  49 }
  50
  51 HRESULT CVersion::Attach()
  52 {
  53     EventWriteWpfHostUm_VersionAttach();
  54
  55     if(m_bIsValid && GetLibraryPath() != NULL)
  56     {
  57         m_hInstance = LoadLibrary(GetLibraryPath());
  58
  59         if(m_hInstance != NULL)
  60         {
  61             m_pfnActivate = (ActivatePfn) GetProcAddress(m_hInstance, "Activate");
  62             m_pfnDeactivate = (DeactivatePfn) GetProcAddress(m_hInstance, "Deactivate");
  63             m_pfnForwardTranslateAccelerator = (ForwardTranslateAcceleratorPfn) GetProcAddress(m_hInstance, "ForwardTranslateAccelerator");
  64             m_pfnSaveToHistory = (SaveToHistoryPfn) GetProcAddress(m_hInstance, "SaveToHistory");
  65             m_pfnLoadFromHistory = (LoadFromHistoryPfn) GetProcAddress(m_hInstance, "LoadFromHistory");
  66
  67             m_bIsAttached =
  68                 m_pfnActivate &&
  69                 m_pfnDeactivate &&
  70                 m_pfnForwardTranslateAccelerator &&
  71                 m_pfnSaveToHistory &&
  72                 m_pfnLoadFromHistory;
  73
  74             // Dev10.582711 - CRT initialization for PresentationCore v3 fails when hosted by PresentationHost v4.
  75             // This is an involved issue, with a history going back to v3.5 SP1.
  76             // See \\ddindex2\sources2\orc----p\wpf\src\core\crtinit.cpp for the initial issue and hacky
  77             // workaround and the above bug for the unfortunate flaw that cropped up in v4.
  78             // The essence of the patch here is that we apply a Fusion activation context for loading the VC 8 CRT
  79             // based on the manifest embedded in PHDLL v3, which is the same as what PresentationCore.dll has
  80             // (as long as they are the same build flavor--this was a caveat about the original workaround too).
  81             // This activation context needs to be active only when PresentationCore (v3) is doing its
  82             // initialization and binding to msvcr80.dll, but it doesn't hurt to keep it active for the whole
  83             // lifetime of the process. In some sense this gives v3 a more compatible runtime environment
  84             // because PH v3 used to have that manifest reference to the VC 8 CRT.
  85             if(m_dwMajor == 3)
  86             {
  87                 ActivationContext actctx;
  88                 if(!actctx.Create(GetLibraryPath()) || !actctx.Activate(false))
  89                 {
  90                     ASSERT(false);
  91                 }
  92             }
  93         }
  94     }
  95
  96     return m_bIsAttached ? S_OK : E_FAIL;
  97 }
  98
  99 void CVersion::ParseVersion(__in_ecount(1) LPCWSTR pswzVersion)
 100 {
 101     DWORD dwNumber[3] = {0,0,0};
 102     // nIndex is used in a loop bounded by a constant (3). Since it is safely bounded we can declare it as __bound to avoid PREFast warnings
 103     __bound UINT nIndex = 0;
 104
 105     m_bIsValid = TRUE;
 106
 107     BOOL bGotOpenQuote = FALSE;
 108
 109     WCHAR* pwcNext = (WCHAR*)pswzVersion;
 110
 111     // Initial quote is allowed and ignored
 112     if (*pwcNext == L'\"')
 113     {
 114         ++pwcNext;
 115         bGotOpenQuote = TRUE;
 116     }
 117
 118     // Intial "v" is allowed, and ignored
 119     if (*pwcNext == 'v' || *pwcNext == 'V')
 120     {
 121         ++pwcNext;
 122     }
 123
 124     while (*pwcNext && nIndex < 3)
 125     {
 126         if (*pwcNext == '.')
 127         {
 128             ++nIndex;
 129         }
 130         else if (iswdigit(*pwcNext))
 131         {
 132             dwNumber[nIndex] *= 10;
 133             dwNumber[nIndex] += *pwcNext - '0';
 134         }
 135         else
 136         {
 137             // Close quote (if it is the last character) is allowed and ignored
 138             if (bGotOpenQuote && *pwcNext == L'\"')
 139             {
 140                 ++pwcNext;
 141                 if (*pwcNext)
 142                 {
 143                     m_bIsValid = FALSE;
 144                     break;
 145                 }
 146             }
 147             else
 148             {
 149                 m_bIsValid = FALSE;
 150                 break;
 151             }
 152         }
 153         ++pwcNext;
 154     }
 155
 156     if (m_bIsValid)
 157     {
 158         m_dwMajor = dwNumber[0];
 159         m_dwMinor = dwNumber[1];
 160         m_dwBuild = dwNumber[2];
 161     }
 162     else
 163     {
 164         m_dwMajor = 0;
 165         m_dwMinor = 0;
 166         m_dwBuild = 0;
 167     }
 168 }
 169
 170 void CVersion::Activate(__in_ecount(1) const ActivateParameters* pParameters, __deref_out_ecount(1) LPUNKNOWN* ppInner)
 171 {
 172     EventWriteWpfHostUm_VersionActivateStart();
 173
 174     m_pfnActivate(pParameters, ppInner); //[supposed to invoke Watson on failure]
 175
 176     EventWriteWpfHostUm_VersionActivateEnd();
 177 }
 178
 179 void CVersion::Deactivate()
 180 {
 181     m_pfnDeactivate();
 182 }
 183
 184 HRESULT CVersion::ForwardTranslateAccelerator(__in_ecount(1) MSG* pMsg)
 185 {
 186     return m_pfnForwardTranslateAccelerator(pMsg, VARIANT_FALSE/*the app wasn't given a chance*/);
 187 }
 188
 189 HRESULT CVersion::SaveToHistory(__in_ecount(1) IStream* pHistoryStream)
 190 {
 191     return m_pfnSaveToHistory(pHistoryStream);
 192 }
 193
 194 HRESULT CVersion::LoadFromHistory(__in_ecount(1) IStream* pHistoryStream, __in_ecount(1) IBindCtx* pBindCtx)
 195 {
 196     return m_pfnLoadFromHistory(pHistoryStream, pBindCtx);
 197 }